Add a dedicated substitution naming provider #377
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
April 27, 2023 21:37
… dictionary of generated names and an alternate to substitute with - Updated the INamingProvider to add two specific Type-based methods for PropertyNameFromAttribute and PropertyNameFromElement, to ensure that custom implementors can split the implementation accordingly. - Updated XmlSchemaClassGenerator.Console to take in command line options for --typeNameSubstitute and typeNameSubstituteFile. What's left: - Update README - Add tests
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## master #377 +/- ##
==========================================
- Coverage 95.52% 94.21% -1.32%
==========================================
Files 20 21 +1
Lines 2930 2973 +43
Branches 462 466 +4
==========================================
+ Hits 2799 2801 +2
- Misses 74 115 +41
Partials 57 57
☔ View full report in Codecov by Sentry. |
|
Thanks a lot! Would be great if you could add unit tests. |
|
Hi @mganss! Thanks heaps for the merge! Yes, I will work on tests for the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reason for PR
A need to specify alternate/replacement names for types and/or properties during generation, specifically from the command line.
Outline of key changes
NamingProviderimplementation,SubstituteNamingProvider, which can store a dictionary of generated names and an alternate to substitute with.INamingProviderto add two specificType-based methods forPropertyNameFromAttributeandPropertyNameFromElement, to ensure that custom implementors can split the implementation accordingly.XmlSchemaClassGenerator.Consoleto accept new command line options:--typeNameSubstitute: For each instance, the{generated}={substituted}value is added to a collection.--typeNameSubstituteFile: For each instance, the containing{generated} = {substituted}lines are added to a collection.READMEto properly document and define cli usage.Related issues:
This may not completely solve all of these issues, but should at least assist with the next steps.
Requests for mercy
NamingProvider). I have submitted this PR as I have a desire for this to be merged before I am able to make time to add tests for both theNamingProviderandSubstituteNamingProviderimplementations. May I request your mercy, and have tests overlooked for this specific PR?